<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDBusObject</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIO Reference Manual">
<link rel="up" href="gdbus-convenience.html" title="Highlevel D-Bus Support">
<link rel="prev" href="GDBusProxy.html" title="GDBusProxy">
<link rel="next" href="GDBusObjectSkeleton.html" title="GDBusObjectSkeleton">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GDBusProxy.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gdbus-convenience.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIO Reference Manual</th>
<td><a accesskey="n" href="GDBusObjectSkeleton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GDBusObject.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GDBusObject.description" class="shortcut">Description</a>
                   | 
                  <a href="#GDBusObject.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GDBusObject.prerequisites" class="shortcut">Prerequisites</a>
                   | 
                  <a href="#GDBusObject.implementations" class="shortcut">Known Implementations</a>
                   | 
                  <a href="#GDBusObject.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GDBusObject"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDBusObject.top_of_page"></a>GDBusObject</span></h2>
<p>GDBusObject — Base type for D-Bus objects</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GDBusObject.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gio/gio.h&gt;

                    <a class="link" href="GDBusObject.html#GDBusObject-struct" title="GDBusObject">GDBusObject</a>;
struct              <a class="link" href="GDBusObject.html#GDBusObjectIface" title="struct GDBusObjectIface">GDBusObjectIface</a>;
const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GDBusObject.html#g-dbus-object-get-object-path" title="g_dbus_object_get_object_path ()">g_dbus_object_get_object_path</a>       (<em class="parameter"><code><a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> *object</code></em>);
<a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GDBusObject.html#g-dbus-object-get-interfaces" title="g_dbus_object_get_interfaces ()">g_dbus_object_get_interfaces</a>        (<em class="parameter"><code><a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> *object</code></em>);
<a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="returnvalue">GDBusInterface</span></a> *    <a class="link" href="GDBusObject.html#g-dbus-object-get-interface" title="g_dbus_object_get_interface ()">g_dbus_object_get_interface</a>         (<em class="parameter"><code><a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> *object</code></em>,
                                                         <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interface_name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GDBusObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----GDBusObject
</pre>
</div>
<div class="refsect1">
<a name="GDBusObject.prerequisites"></a><h2>Prerequisites</h2>
<p>
GDBusObject requires
 <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="GDBusObject.implementations"></a><h2>Known Implementations</h2>
<p>
GDBusObject is implemented by
 <a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy">GDBusObjectProxy</a> and  <a class="link" href="GDBusObjectSkeleton.html" title="GDBusObjectSkeleton">GDBusObjectSkeleton</a>.</p>
</div>
<div class="refsect1">
<a name="GDBusObject.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GDBusObject.html#GDBusObject-interface-added" title='The "interface-added" signal'>interface-added</a>"                                : <a href="./../gobject/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="GDBusObject.html#GDBusObject-interface-removed" title='The "interface-removed" signal'>interface-removed</a>"                              : <a href="./../gobject/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GDBusObject.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> type is the base type for D-Bus objects on both
the service side (see <a class="link" href="GDBusObjectSkeleton.html" title="GDBusObjectSkeleton"><span class="type">GDBusObjectSkeleton</span></a>) and the client side
(see <a class="link" href="GDBusObjectProxy.html" title="GDBusObjectProxy"><span class="type">GDBusObjectProxy</span></a>). It is essentially just a container of
interfaces.
</p>
</div>
<div class="refsect1">
<a name="GDBusObject.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GDBusObject-struct"></a><h3>GDBusObject</h3>
<pre class="programlisting">typedef struct _GDBusObject GDBusObject;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GDBusObjectIface"></a><h3>struct GDBusObjectIface</h3>
<pre class="programlisting">struct GDBusObjectIface {
  GTypeInterface parent_iface;

  /* Virtual Functions */
  const gchar     *(*get_object_path) (GDBusObject  *object);
  GList           *(*get_interfaces)  (GDBusObject  *object);
  GDBusInterface  *(*get_interface)   (GDBusObject  *object,
                                       const gchar  *interface_name);

  /* Signals */
  void (*interface_added)   (GDBusObject     *object,
                             GDBusInterface  *interface_);
  void (*interface_removed) (GDBusObject     *object,
                             GDBusInterface  *interface_);
};
</pre>
<p>
Base object type for D-Bus objects.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="./../gobject/gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GDBusObjectIface.parent-iface"></a>parent_iface</code></em>;</span></p></td>
<td>The parent interface.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GDBusObjectIface.get-object-path"></a>get_object_path</code></em> ()</span></p></td>
<td>Returns the object path. See <a class="link" href="GDBusObject.html#g-dbus-object-get-object-path" title="g_dbus_object_get_object_path ()"><code class="function">g_dbus_object_get_object_path()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GDBusObjectIface.get-interfaces"></a>get_interfaces</code></em> ()</span></p></td>
<td>Returns all interfaces. See <a class="link" href="GDBusObject.html#g-dbus-object-get-interfaces" title="g_dbus_object_get_interfaces ()"><code class="function">g_dbus_object_get_interfaces()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GDBusObjectIface.get-interface"></a>get_interface</code></em> ()</span></p></td>
<td>Returns an interface by name. See <a class="link" href="GDBusObject.html#g-dbus-object-get-interface" title="g_dbus_object_get_interface ()"><code class="function">g_dbus_object_get_interface()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GDBusObjectIface.interface-added"></a>interface_added</code></em> ()</span></p></td>
<td>Signal handler for the <a class="link" href="GDBusObject.html#GDBusObject-interface-added" title='The "interface-added" signal'><span class="type">"interface-added"</span></a> signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GDBusObjectIface.interface-removed"></a>interface_removed</code></em> ()</span></p></td>
<td>Signal handler for the <a class="link" href="GDBusObject.html#GDBusObject-interface-removed" title='The "interface-removed" signal'><span class="type">"interface-removed"</span></a> signal.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="g-dbus-object-get-object-path"></a><h3>g_dbus_object_get_object_path ()</h3>
<pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       g_dbus_object_get_object_path       (<em class="parameter"><code><a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> *object</code></em>);</pre>
<p>
Gets the object path for <em class="parameter"><code>object</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>A <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string owned by <em class="parameter"><code>object</code></em>. Do not free.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="g-dbus-object-get-interfaces"></a><h3>g_dbus_object_get_interfaces ()</h3>
<pre class="programlisting"><a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             g_dbus_object_get_interfaces        (<em class="parameter"><code><a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> *object</code></em>);</pre>
<p>
Gets the D-Bus interfaces associated with <em class="parameter"><code>object</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>A <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>(element-type GDBusInterface) (transfer full) : A list of <a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> instances.
The returned list must be freed by <a href="./../glib/glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a> after each element has been freed
with <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="g-dbus-object-get-interface"></a><h3>g_dbus_object_get_interface ()</h3>
<pre class="programlisting"><a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="returnvalue">GDBusInterface</span></a> *    g_dbus_object_get_interface         (<em class="parameter"><code><a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> *object</code></em>,
                                                         <em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *interface_name</code></em>);</pre>
<p>
Gets the D-Bus interface with name <em class="parameter"><code>interface_name</code></em> associated with
<em class="parameter"><code>object</code></em>, if any.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>A <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>interface_name</code></em> :</span></p></td>
<td>A D-Bus interface name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found, otherwise a
<a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> that must be freed with <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
</div>
<div class="refsect1">
<a name="GDBusObject.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GDBusObject-interface-added"></a><h3>The <code class="literal">"interface-added"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a>    *object,
                                                        <a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> *interface,
                                                        <a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)      : <a href="./../gobject/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when <em class="parameter"><code>interface</code></em> is added to <em class="parameter"><code>object</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>The <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> emitting the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>interface</code></em> :</span></p></td>
<td>The <a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> that was added.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
<hr>
<div class="refsect2">
<a name="GDBusObject-interface-removed"></a><h3>The <code class="literal">"interface-removed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a>    *object,
                                                        <a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> *interface,
                                                        <a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)      : <a href="./../gobject/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Emitted when <em class="parameter"><code>interface</code></em> is removed from <em class="parameter"><code>object</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>The <a class="link" href="GDBusObject.html" title="GDBusObject"><span class="type">GDBusObject</span></a> emitting the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>interface</code></em> :</span></p></td>
<td>The <a class="link" href="GDBusInterface.html" title="GDBusInterface"><span class="type">GDBusInterface</span></a> that was removed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.30</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>